Skip to content

docs: fill SDK reference gaps (type conversions, EVM helpers, secrets)#3516

Merged
dev-dist merged 2 commits intomainfrom
docs/sdk-reference-gaps
Mar 5, 2026
Merged

docs: fill SDK reference gaps (type conversions, EVM helpers, secrets)#3516
dev-dist merged 2 commits intomainfrom
docs/sdk-reference-gaps

Conversation

@wentzeld
Copy link
Contributor

@wentzeld wentzeld commented Mar 2, 2026

Summary

  • New page: type-conversions-ts.mdx — Type vs TypeJson system, ProtoBigInt, conversion table
  • EVM helpers: Added hexToBytes, base64ToHex, bigintToBytes, bytesToBigint, bigintToProtoBigInt to evm-client-ts.mdx
  • UnwrapOptions: Added subsection to core-ts.mdx explaining the three deserialization variants for runInNodeMode
  • Secrets API: Added runtime.getSecret() to core-ts.mdx and runtime.GetSecret() to core-go.mdx
  • Cross-links: Sidebar entry, overview-ts bullet, confidential-http-client-ts Aside update

Test plan

  • Verify local dev server renders all new/edited pages without errors
  • Check sidebar shows "Type Conversions" entry after "Consensus & Aggregation"
  • Verify all cross-links resolve to valid pages
  • Review code examples for accuracy against SDK source

@vercel
Copy link

vercel bot commented Mar 2, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Mar 5, 2026 9:41pm

Request Review

…e notes and changelog

SDK reference additions (type conversions, EVM helpers, UnwrapOptions, Secrets API):
- Add type-conversions-ts.mdx (Type vs TypeJson, ProtoBigInt, bytes helpers)
- Add 5 missing EVM helper functions to evm-client-ts.mdx
- Add UnwrapOptions subsection and runtime.getSecret() to core-ts.mdx
- Add runtime.GetSecret() to core-go.mdx
- Add sidebar entry and cross-links from overview-ts and confidential-http-client-ts

Accuracy fixes:
- Remove base64ToHex() — function does not exist in @chainlink/cre-sdk
- Fix hexToBytes() signature: hex: Hex → hex: string
- Fix UnwrapOptions type definition to match actual SDK (conditional, mutually exclusive schema/factory)
- Remove incorrect SecretsProvider parameter from TS initWorkflow example
- Mark namespace field as optional (not required) in SecretRequest tables for both SDKs

Release notes and changelog backfill:
- Add Go SDK v1.3.0–v1.5.0 release notes
- Add TS SDK v1.1.0 release notes
- Add corresponding entries to changelog.json
- Regenerate llms-full-go.txt and llms-full-ts.txt

Made-with: Cursor
@dev-dist dev-dist force-pushed the docs/sdk-reference-gaps branch from 8d9afa0 to d32c9bc Compare March 5, 2026 21:31
@dev-dist dev-dist marked this pull request as ready for review March 5, 2026 21:32
@dev-dist dev-dist requested a review from a team as a code owner March 5, 2026 21:32
@dev-dist dev-dist merged commit 955b00e into main Mar 5, 2026
22 checks passed
@dev-dist dev-dist deleted the docs/sdk-reference-gaps branch March 5, 2026 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants